-
Notifications
You must be signed in to change notification settings - Fork 164
Add Independent Agent Release doc #2824
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Independent Agent Release doc #2824
Conversation
🔍 Preview links for changed docs |
cc @elastic/fleet @elastic/elastic-agent |
|
||
{{agent}} follows a release process aligned with the broader Elastic Stack release schedule. Changes and fixes are documented in the [release notes](../../release-notes/fleet-elastic-agent/index.md). | ||
|
||
## Independent Agent Release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we use sentence case here? (For reference, see our Capitalization and Capitalization of abbreviations guidelines.)
## Independent Agent Release | |
## Independent agent release |
Also a thought: I feel this term IAR may be accepted and widely used internally, but wouldn’t it be more clearer and more unambiguous for users if this were called independent Elastic Agent release? But I see that then the acronym would need to change, and maybe we’ve already communicated this to users… in which case maybe that won’t work. But if we’re just starting to use IAR, maybe we can replace it with IEAR?:)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed the capitalization 👍
I haven't found any other external documentation mentioning IAR, but as you said this acronym is already established internally. cc @karenzone @cmacknz
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes technically it should be independent Elastic Agent Release and we could just not use the IAR acronym in public docs.
reference/fleet/toc.yml
Outdated
- file: fleet-server-monitoring.md | ||
- file: install-elastic-agents.md | ||
children: | ||
- file: fleet-agent-release.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’m a bit unsure about where to place this doc:
-
Leave it in its current place under Install Elastic Agents
-
Move it one level up under the Fleet and Elastic Agent, e.g.:
toc: - file: index.md - file: fleet-agent-serverless-restrictions.md - file: beats-agent-comparison.md + - file: fleet-agent-release.md
-
Or maybe just add its content as part of the
reference/fleet/index.md
.
I’d like to ask for help... @karenzone what do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, this is a nice feature and nice new docs content.
Best practice is to lead with most common workflows and then work down to less common ones. I like the addition of the Elastic Agent release process page to add context to the new Elastic Agent release process, but the "normal" release process (first paragraph) is easily overlooked. with the eye jumping to the next heading.
A fix could be as simple as adding a heading before the first paragraph to make it more obvious, and offer contrast to the independent process. I'm not proposing this exact wording, but something like "Regular" or " Scheduled" stack releases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
…or upgrade (#234198) ## Summary Closes #228494 This PR adds informational UI elements when an independent agent release (IAR) version is selected when upgrading Fleet managed Elastic Agents in Fleet UI, in the upgrade agents confirm modal: * Show a tooltip when hovering on an IAR version in the version selection dropdown menu * Render an info callout with a link to the documentation (new page created in elastic/docs-content#2824) when an IAR version is selected Screen recording showing affected flows: https://github.com/user-attachments/assets/9d7e9a39-f4f2-4145-b730-ccc3ff91b94e ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks This change only renders additional informational UI elements, risk is minimal.
…or upgrade (elastic#234198) ## Summary Closes elastic#228494 This PR adds informational UI elements when an independent agent release (IAR) version is selected when upgrading Fleet managed Elastic Agents in Fleet UI, in the upgrade agents confirm modal: * Show a tooltip when hovering on an IAR version in the version selection dropdown menu * Render an info callout with a link to the documentation (new page created in elastic/docs-content#2824) when an IAR version is selected Screen recording showing affected flows: https://github.com/user-attachments/assets/9d7e9a39-f4f2-4145-b730-ccc3ff91b94e ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks This change only renders additional informational UI elements, risk is minimal.
…or upgrade (elastic#234198) ## Summary Closes elastic#228494 This PR adds informational UI elements when an independent agent release (IAR) version is selected when upgrading Fleet managed Elastic Agents in Fleet UI, in the upgrade agents confirm modal: * Show a tooltip when hovering on an IAR version in the version selection dropdown menu * Render an info callout with a link to the documentation (new page created in elastic/docs-content#2824) when an IAR version is selected Screen recording showing affected flows: https://github.com/user-attachments/assets/9d7e9a39-f4f2-4145-b730-ccc3ff91b94e ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks This change only renders additional informational UI elements, risk is minimal.
…or upgrade (elastic#234198) ## Summary Closes elastic#228494 This PR adds informational UI elements when an independent agent release (IAR) version is selected when upgrading Fleet managed Elastic Agents in Fleet UI, in the upgrade agents confirm modal: * Show a tooltip when hovering on an IAR version in the version selection dropdown menu * Render an info callout with a link to the documentation (new page created in elastic/docs-content#2824) when an IAR version is selected Screen recording showing affected flows: https://github.com/user-attachments/assets/9d7e9a39-f4f2-4145-b730-ccc3ff91b94e ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks This change only renders additional informational UI elements, risk is minimal.
…or upgrade (#234198) ## Summary Closes #228494 This PR adds informational UI elements when an independent agent release (IAR) version is selected when upgrading Fleet managed Elastic Agents in Fleet UI, in the upgrade agents confirm modal: * Show a tooltip when hovering on an IAR version in the version selection dropdown menu * Render an info callout with a link to the documentation (new page created in elastic/docs-content#2824) when an IAR version is selected Screen recording showing affected flows: https://github.com/user-attachments/assets/9d7e9a39-f4f2-4145-b730-ccc3ff91b94e ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks This change only renders additional informational UI elements, risk is minimal.
Relates elastic/kibana#228494
We want to provide information about the Independent Agent Release (IAR) process to users.
This PR adds:
Screenshots
New "Elastic Agent release process" page:

Edit to "Fleet and Elastic Agent / Manage Elastic Agents in Fleet / Upgrade Fleet-managed Elastic Agents":
